/*
 * Copyright (c) 2012, Markus Weber All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer. Redistributions in binary form must reproduce the
 * above copyright notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
package de.dfki.graph;

/**
 * String label
 *
 * @author Markus Weber
 *
 */
public class StringLabel implements LabelType<String>, Comparable<StringLabel> {

    /**
     * String label
     */
    private String str;
    /**
     * Weight assigned to the label.
     */
    private byte weight;

    /**
     * Constructor
     *
     * @param str
     * @param weight
     */
    public StringLabel(String str, byte weight) {
        super();
        this.str = str;
        this.weight = weight;
    }

    /**
     * Constructor
     *
     * @param string
     */
    public StringLabel(String str) {
        this.str = str;
    }

    /*
     * (non-Javadoc) @see de.dfki.structures.LabelType#getWeight()
     */
    @Override
    public byte getWeight() {
        return weight;
    }

    /*
     * (non-Javadoc) @see de.dfki.structures.LabelType#getValue()
     */
    @Override
    public String getValue() {
        return str;
    }

    /*
     * (non-Javadoc) @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((str == null) ? 0 : str.hashCode());
        return result;
    }

    /*
     * (non-Javadoc) @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        StringLabel other = (StringLabel) obj;
        if (str == null) {
            if (other.str != null) {
                return false;
            }
        } else if (!str.equals(other.str)) {
            return false;
        }
        return true;
    }

    /*
     * (non-Javadoc) @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return this.getValue();
    }

    /*
     * (non-Javadoc) @see de.dfki.structures.LabelType#updateWeight(byte)
     */
    @Override
    public void updateWeight(byte weight) {
        this.weight = weight;
    }

    /*
     * (non-Javadoc) @see java.lang.Comparable#compareTo(java.lang.Object)
     */
    @Override
    public int compareTo(StringLabel o) {
        if (o.getWeight() == this.getWeight()) {
            return 0;
        } else if (this.getWeight() > o.getWeight()) {
            return 1;
        }
        return -1;
    }
}
